

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<script type="text/javascript" src="helpman_topicinit.js"></script>

<title>Project [Enterprise Architect User Guide]</title>

<meta name="keywords" content="Enterprise Architect, Sparx Systems, UML, Automation Interface,Automation Interface Project, Project Interface,Project Interface,Project Interface Project">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />

<link type="text/css" href="default.css" rel="stylesheet" />
<style type="text/css">
  A, A:Visited
  {
    color: #00F;
  }

  A:Active, A:Hover
  {
    color: #F00;
  }

  OL
  {
    margin: 5px 0 5px 48px;
  }

  UL
  {
    margin-bottom: 3px;
    margin-top: 0;
  }

  #nsr
  {
    background-color: #D4DFFF;
  }

  #nsr A
  {
    text-decoration: none;
  }

  #mainbody
  {
    padding: 8px;
  }

  .p_BodyText
  {
    padding: 5px 0;
  }
</style>



<style type="text/css" media="screen">
  BODY
  {
    background-color: #FFFFFF;
  }

  #nsr
  {
    padding: 6px 6px 0 6px;
    border-bottom: none;
    vertical-align: top;
    z-index: 2;
    visibility: visible;
    left: 0;
    top: 0;
    position: absolute;
  }

  #mainbody
  {
    left: 0;
    top: 0;
    margin: 0;
    position: absolute;
    padding: 10px;
    overflow: auto;
    height: 100%;
    z-index: 1;
    background-repeat: no-repeat;
    background-position: bottom right;
    background-attachment: fixed;
  }
</style>

<style type="text/css" media="print">
  #nsr
  {
    visibility: none;
  }

  #mainbody
  {
    overflow: visible;
  }
</style>
<script type="text/javascript" language="JavaScript" src="nonscroll.js"></script>

</head>
<body scroll="no">

<div id="page">



        <div id="content">
          <div id="content-inner">
          



  
          <div id="nsr">
            <table border="0" cellspacing="0" cellpadding="4" width="100%">
              <tr valign="top">
                <td align="left">
  


                  <p class="p_Heading1"><span class="f_Heading1">Project</span></p>



  
                </td>
                <td align="right">
                  <a href="introduction.htm" onmouseover="document.images.main.src='button_main_h.gif'" onmouseout="document.images.main.src='button_main.gif'">
                    <img name="main" src="button_main.gif" border=0 alt="Return to Introduction">
                  </a>&nbsp;
    
                  <a href="projectinterface.htm" onmouseover="document.images.prev.src='button_prev_h.gif'" onmouseout="document.images.prev.src='button_prev.gif'">
                    <img name=prev src="button_prev.gif" border=0 alt="Previous page" />
                  </a>&nbsp;
    
    
    
                  <a href="codeexamples.htm" onmouseover="document.images.next.src='button_next_h.gif'" onmouseout="document.images.next.src='button_next.gif'">
                    <img name=next src="button_next.gif" border=0 alt="Next page" />
                  </a>
    
    
                </td>
              </tr>
            </table>
          </div>
          <div id="mainbody">
  


                <p class="p_SubHeadingL1"><span class="f_SubHeadingL1">public Class</span></p>
<p class="p_BodyText"><span class="f_BodyText">The Project interface can be accessed from the Repository using </span><span class="f_BodyText" style="font-style: italic;">GetProjectInterface()</span><span class="f_BodyText">. The returned interface provides access to the XML-based Enterprise Architect Automation Interface. Use this interface to get XML for the various internal elements and to run some utility functions to perform tasks such as load diagrams or run reports.</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" width="952" bgcolor="#efeff7" style="width:952px; background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Note:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td width="952" bgcolor="#f7f7ff" style="width:952px; background-color:#f7f7ff;"><p class="p_TiporNoteText"><span class="f_TiporNoteText">These methods all require input GUIDs in XML format; use </span><span class="f_TiporNoteText"><a href="project_2.htm#GUIDXML">GUIDtoXML</a></span><span class="f_TiporNoteText"> to change the Enterprise Architect GUID to an XML GUID.</span></p>
</td>
</tr>
</table>
</div>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Project Attributes</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="0" border="0" style="border: none; border-spacing:0px; border-collapse: collapse;">
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="201" bgcolor="#e3e6ed" style="width:201px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Attribute</span></p>
</td>
<td valign="top" width="112" bgcolor="#e3e6ed" style="width:112px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Type</span></p>
</td>
<td valign="top" width="351" bgcolor="#e3e6ed" style="width:351px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Notes</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="201" style="width:201px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ObjectType</span></p>
</td>
<td valign="top" width="112" style="width:112px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;"><a href="objecttypeenum.htm">ObjectType</a></span></p>
</td>
<td valign="top" width="351" style="width:351px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read only. Distinguishes objects referenced through a Dispatch interface.</span></p>
</td>
</tr>
</table>
</div>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Project Methods</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="0" border="0" style="border: none; border-spacing:0px; border-collapse: collapse;">
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" bgcolor="#e3e6ed" style="width:200px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Method</span></p>
</td>
<td valign="top" width="116" bgcolor="#e3e6ed" style="width:116px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Type</span></p>
</td>
<td valign="top" width="339" bgcolor="#e3e6ed" style="width:339px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Notes</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">CreateBaseline (s</span><span class="f_Tabletext" style="font-weight: bold;">tring PackageGUID, string Version, string Notes</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Creates a Baseline of a specified package.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">PackageGUID: String - t</span><span class="f_Bulletlist1">he GUID (in XML format) of the package to Baseline.</span></li>
<li><span class="f_Bulletlist1">Version: String - t</span><span class="f_Bulletlist1">he version of the Baseline.</span></li>
<li><span class="f_Bulletlist1">Notes: String - any notes concerning the Baseline.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><a name="dr"></a><span class="f_Tabletext" style="font-weight: bold;">DefineRule (string CategoryID, EA.EnumMVErrorType ErrorType, string ErrorMessage</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Defines the individual rules that can be performed during model validation. It must be called once for each rule from the </span><span class="f_Tabletext" style="font-style: italic;"><a href="ea_oninitializeuserrules.htm">EA_OnInitializeUserRules</a></span><span class="f_Tabletext"> broadcast handler.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">CategoryId: String - should be passed the return value from the </span><span class="f_Bulletlist1" style="font-style: italic;"><a href="project_2.htm#DRC">DefineRuleCategory</a></span><span class="f_Bulletlist1"> method. </span></li>
<li><span class="f_Bulletlist1">ErrorType:EA.EnumMVErrorType - depending on the severity of the error being validated, can be:</span></li>
</ul>
<ul style="text-indent: 0px; margin-left: 65px; list-style-position: outside;">
<li><span class="f_Bulletlist3" style="font-weight: bold;">mvErrorCritical</span></li>
<li><span class="f_Bulletlist3" style="font-weight: bold;">mvError</span></li>
<li><span class="f_Bulletlist3" style="font-weight: bold;">mvWarning</span><span class="f_Bulletlist3">, or </span></li>
<li><span class="f_Bulletlist3" style="font-weight: bold;">mvInformation</span><span class="f_Bulletlist1" style="font-weight: bold;">. </span></li>
</ul>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">ErrorMessage: String - can contain a default error string, although this is probably overridden by the </span><span class="f_Bulletlist1" style="font-style: italic;">PublishResult</span><span class="f_Bulletlist1"> call.</span></li>
</ul>
<p class="p_Tabletext"><span class="f_Tabletext">The return value is a </span><span class="f_Tabletext" style="font-style: italic;">RuleId</span><span class="f_Tabletext">, which can be used for reference purposes when an individual rule is executed by Enterprise Architect during model validation. </span></p>
<p class="p_Tabletext"><span class="f_Tabletext">See <a href="model_validation_example.htm">Model Validation Example</a> for a detailed example of use of this method.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><a name="drc"></a><span class="f_Tabletext" style="font-weight: bold;">DefineRuleCategory (string CategoryName)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Defines a category of rules that can be performed during model validation (there is typically one category per Add-In). It must be called once from the </span><span class="f_Tabletext" style="font-style: italic;"><a href="ea_oninitializeuserrules.htm">EA_OnInitializeUserRules</a></span><span class="f_Tabletext"> broadcast handler.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">CategoryName: String - a text string that is visible in the </span><span class="f_UIControl">Model Validation Configuration</span><span class="f_Bulletlist1"> dialog. </span></li>
</ul>
<p class="p_Tabletext"><span class="f_Tabletext">The return value is a </span><span class="f_Tabletext">CategoryId</span><span class="f_Tabletext"> that must to be passed to the </span><span class="f_Tabletext" style="font-style: italic;"><a href="project_2.htm#DR">DefineRule</a> </span><span class="f_Tabletext">method. </span></p>
<p class="p_Tabletext"><span class="f_Tabletext">See <a href="model_validation_example.htm">Model Validation Example</a> for a detailed example of use of this method.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><a name="compare"></a><span class="f_Tabletext" style="font-weight: bold;">DoBaselineCompare</span><br>
<span class="f_Tabletext" style="font-weight: bold;">(s</span><span class="f_Tabletext" style="font-weight: bold;">tring PackageGUID, string Baseline, string ConnectString</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Performs a Baseline comparison using the supplied package GUID and Baseline GUID (obtained in the result list from </span><span class="f_Tabletext" style="font-style: italic;"><a href="project_2.htm#Get">GetBaselines</a></span><span class="f_Tabletext">).</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Optionally you can include the connection string required to find the Baseline if it exists in a different model file.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">This method returns a log file of the status of all elements found and compared in the difference procedure. You can use this log information as input to </span><span class="f_Tabletext" style="font-style: italic;"><a href="project_2.htm#Merge">DoBaselineMerge</a></span><span class="f_Tabletext"> - automatically merging information from the Baseline.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">PackageGUID: String - t</span><span class="f_Bulletlist1">he GUID (in XML format) of the package to run the comparison on.</span></li>
<li><span class="f_Bulletlist1">Baseline: String - t</span><span class="f_Bulletlist1">he GUID (in XML format) of the Baseline to run the comparison on.</span></li>
<li><span class="f_Bulletlist1">ConnectString: String - the location of the external .EAP file or DBMS to extract the Baseline from.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><a name="merge"></a><span class="f_Tabletext" style="font-weight: bold;">DoBaselineMerge</span><br>
<span class="f_Tabletext" style="font-weight: bold;">(string PackageGUID, string Baseline, string MergeInstructions, string ConnectString</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Performs a batch merge based on instructions contained in an XML file (</span><span class="f_Tabletext" style="font-style: italic;">MergeInstructions</span><span class="f_Tabletext">). You can supply an optional connection string if the Baseline is located in another model.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">PackageGUID: String - t</span><span class="f_Bulletlist1">he GUID (in XML format) of the package to merge the Baseline into.</span></li>
<li><span class="f_Bulletlist1">Baseline: String - the GUID of the Baseline (in XML format) to merge into the package.</span></li>
<li><span class="f_Bulletlist1">MergeInstructions: String - the file containing the </span><span class="f_Bulletlist1">GUID of each differenced item from the XML difference log returned by </span><span class="f_Bulletlist1"><a href="project_2.htm#Compare">DoBaselineCompare()</a></span><span class="f_Bulletlist1">.</span></li>
<li><span class="f_Bulletlist1">ConnectString: String </span><span class="f_Bulletlist1"> - the location of the EAP file or DBMS to get the Baseline from, if not in the same model as the package.</span></li>
</ul>
<p class="p_Tabletext"><span class="f_Tabletext">In the </span><span class="f_Tabletext" style="font-style: italic;">MergeInstructions</span><span class="f_Tabletext"> file, each </span><span class="f_Tabletext" style="font-style: italic;">MergeItem</span><span class="f_Tabletext"> node supplies the GUID of a differenced item from the XML difference log. As the merge is uni-directional and actioned in only one possible way, no additional arguments are required. Enterprise Architect chooses the correct procedure based on the Difference results.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">&lt;Merge&gt;</span></p>
<p class="p_Tabletext"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Tabletext" style="font-style: italic;">&lt;MergeItem guid=&quot;{XXXXXX}&quot; /&gt;</span></p>
<p class="p_Tabletext"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Tabletext" style="font-style: italic;">&lt;MergeItem guid=&quot;{XXXXXX}&quot; /&gt;</span></p>
<p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">&lt;/Merge&gt;</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Alternatively, you can supply a single </span><span class="f_Tabletext" style="font-style: italic;">Mergeitem</span><span class="f_Tabletext"> with a GUID of </span><span class="f_Tabletext" style="font-style: italic;">RestoreAll</span><span class="f_Tabletext">. In this case, Enterprise Architect batch-processes ALL differences.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">&lt;Merge&gt;</span></p>
<p class="p_Tabletext"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Tabletext" style="font-style: italic;">&lt;MergeItem guid=&quot;RestoreAll&quot; /&gt;</span></p>
<p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">&lt;/Merge&gt;</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">EnumDiagramElements (s</span><span class="f_Tabletext" style="font-weight: bold;">tring DiagramGUID</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Gets an XML list of all elements in a diagram.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">DiagramGUID: String - the GUID (in XML format) of the diagram to get elements for.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">EnumDiagrams (s</span><span class="f_Tabletext" style="font-weight: bold;">tring PackageGUID</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Gets an XML list of all diagrams in a specified package.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">PackageGUID: String - the GUID (in XML format) of the package to list diagrams for.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">EnumElements (s</span><span class="f_Tabletext" style="font-weight: bold;">tring PackageGUID</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Gets an XML list of elements in a specified package.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">PackageGUID: String - the GUID (in XML format) of the package to get a list of elements for.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">EnumLinks (s</span><span class="f_Tabletext" style="font-weight: bold;">tring ElementGUID</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Gets an XML list of connectors for a specified element.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">ElementGUID: String - the GUID (in XML format) of the element to get all associated connectors for.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">EnumPackages (s</span><span class="f_Tabletext" style="font-weight: bold;">tring PackageGUID</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Gets an XML list of child packages inside a parent package.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">PackageGUID: String - the GUID (in XML format) of the parent package.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">EnumProjects ()</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Gets a list of projects in the current file; corresponds to </span><span class="f_Tabletext" style="font-style: italic;"><a href="repository3.htm#Models">Models</a></span><span class="f_Tabletext"> in </span><span class="f_Tabletext" style="font-style: italic;">Repository</span><span class="f_Tabletext">.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">EnumViews ()</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Enumerates the Views for a project. Returned as an XML document.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">EnumViewEx (s</span><span class="f_Tabletext" style="font-weight: bold;">tring ProjectGUID</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Gets a list of Views in the current project.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">ProjectGUID: String - the GUID (in XML format) of the project to get views for.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Exit ()</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Exits the current instance of Enterprise Architect; this function is maintained for backward compatibility and should never be called.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Enterprise Architect automatically exits when you are no longer using any of the provided objects.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ExportPackageXMI </span><span class="f_Tabletext" style="font-weight: bold;">(string PackageGUID, enumXMIType XMIType, long DiagramXML, long DiagramImage, long FormatXML, long UseDTD, string FileName)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Exports XMI for a specified package.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">PackageGUID: String - the GUID (in XML format) of the package</span><span class="f_Bulletlist1"> to be exported.</span></li>
<li><span class="f_Bulletlist1">XMIType: EnumXMIType</span><span class="f_Tabletext"> - specifies the XMI type and version information; see </span><span class="f_Tabletext" style="font-style: italic;"><a href="xmitypeenum.htm">XMIType Enum</a></span><span class="f_Tabletext"> for accepted values.</span></li>
<li><span class="f_Bulletlist1">DiagramXML: Long - </span><span class="f_Bulletlist1" style="font-weight: bold;">true</span><span class="f_Bulletlist1"> if XML for diagrams is required; </span><span class="f_Bulletlist1">accepted values:</span><br>
<span class="f_Bulletlist1" style="font-weight: bold;">0</span><span class="f_Bulletlist1"> = Do not export diagrams</span><br>
<span class="f_Bulletlist1" style="font-weight: bold;">1</span><span class="f_Bulletlist1"> = Export diagrams</span><br>
<span class="f_Bulletlist1" style="font-weight: bold;">2</span><span class="f_Bulletlist1"> = Export diagrams along with alternate images.</span></li>
<li><span class="f_Bulletlist1">DiagramImage: Long - the f</span><span class="f_Bulletlist1">ormat for diagram images to be created at the same time; accepted values:</span><br>
<span class="f_Bulletlist1" style="font-weight: bold;">-1</span><span class="f_Bulletlist1">=NONE</span><br>
<span class="f_Bulletlist1" style="font-weight: bold;">0</span><span class="f_Bulletlist1">=EMF</span><br>
<span class="f_Bulletlist1" style="font-weight: bold;">1</span><span class="f_Bulletlist1">=BMP</span><br>
<span class="f_Bulletlist1" style="font-weight: bold;">2</span><span class="f_Bulletlist1">=GIF</span><br>
<span class="f_Bulletlist1" style="font-weight: bold;">3</span><span class="f_Bulletlist1">=PNG</span><br>
<span class="f_Bulletlist1" style="font-weight: bold;">4</span><span class="f_Bulletlist1">=JPG.</span></li>
<li><span class="f_Bulletlist1">FormatXML: Long - </span><span class="f_Bulletlist1" style="font-weight: bold;">true</span><span class="f_Bulletlist1"> if XML output should be formatted prior to saving.</span></li>
<li><span class="f_Tabletext">U</span><span class="f_Bulletlist1">s</span><span class="f_Tabletext">eDTD: Long - </span><span class="f_Tabletext" style="font-weight: bold;">true</span><span class="f_Tabletext"> if a DTD should be used.</span></li>
<li><span class="f_Bulletlist1">FileName: String - the filename to output to.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">GenerateClass (</span><span class="f_Tabletext" style="font-weight: bold;">string ElementGUID, string ExtraOptions</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Generates the code for a single Class.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">ElementGUID: String - the GUID (in XML format) of the element to generate.</span></li>
<li><span class="f_Bulletlist1">ExtraOptions: String - enables extra options to be given to the command; currently unused.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">GeneratePackage (s</span><span class="f_Tabletext" style="font-weight: bold;">tring Package GUID, string ExtraOptions</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Generates the code for all Classes within a package.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">PackageGUID: String - the GUID (in XML format) of the package to generate.</span></li>
<li><span class="f_Bulletlist1">ExtraOptions: String - enables extra options to be given to the command; currently enables:</span></li>
</ul>
<ul style="text-indent: 0px; margin-left: 48px; list-style-position: outside;">
<li><span class="f_Bulletlist2">Generation of all subpackages (</span><span class="f_Bulletlist2" style="font-style: italic;">recurse</span><span class="f_Bulletlist2">)</span></li>
<li><span class="f_Bulletlist2">Force overwrite of all files (</span><span class="f_Bulletlist2" style="font-style: italic;">overwrite</span><span class="f_Bulletlist2">) and</span></li>
<li><span class="f_Bulletlist2">Specification to auto generate all paths </span><br>
<span class="f_Bulletlist2">(</span><span class="f_Bulletlist2" style="font-style: italic;">dir</span><span class="f_Bulletlist2">).</span></li>
</ul>
<p class="p_Tabletext"><span class="f_Tabletext">For example: </span><span class="f_Code">recurse=</span><span class="f_Code">1</span><span class="f_Code">;overwrite=</span><span class="f_Code">1</span><span class="f_Code">;dir=</span><span class="f_Code">C:\</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">GenerateXSD (s</span><span class="f_Tabletext" style="font-weight: bold;">tring PackageGUID, string FileName, string Encoding, string Options</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Creates an XML schema for this GenerateXSD. Returns </span><span class="f_Tabletext" style="font-weight: bold;">true</span><span class="f_Tabletext"> on success.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">PackageGUID: String - the GUID (in XML format) of the package.</span></li>
<li><span class="f_Bulletlist1">FileName: String - target filepath.</span></li>
<li><span class="f_Bulletlist1">Encoding: String - the XML encoding for the code page instruction.</span></li>
<li><span class="f_Bulletlist1">Options: String - enables extra options to be given to the command; currently enables:</span></li>
</ul>
<ul style="text-indent: 0px; margin-left: 48px; list-style-position: outside;">
<li><span class="f_Bulletlist2" style="font-style: italic;">GenGlobalElement</span><span class="f_Bulletlist2"> - turn the generation of global elements for all global </span><span class="f_Bulletlist2" style="font-style: italic;">ComplexTypes</span><span class="f_Bulletlist2"> </span><span class="f_Bulletlist2" style="font-weight: bold;">On</span><span class="f_Bulletlist2"> or </span><span class="f_Bulletlist2" style="font-weight: bold;">Off</span><span class="f_Bulletlist2">; for example: - </span><span class="f_Code">GenGlobalElement=1.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><a name="get"></a><span class="f_Tabletext" style="font-weight: bold;">GetBaselines (s</span><span class="f_Tabletext" style="font-weight: bold;">tring PackageGUID, string ConnectString</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Returns a list (in XML format) of Baselines associated with the supplied package GUID. Optionally, you can provide a connection string to get Baselines from the same package, but located in a different model file (or DBMS).</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">PackageGUID: String - the </span><span class="f_Bulletlist1"> GUID (in XML format) of the package</span><span class="f_Bulletlist1"> to get Baselines for.</span></li>
<li><span class="f_Bulletlist1">ConnectString: String - the location of the EAP file or DBMS to get the Baselines from, if not in the same model as the package.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">GetDiagram </span><span class="f_Tabletext" style="font-style: italic; font-weight: bold;">(s</span><span class="f_Tabletext" style="font-weight: bold;">tring DiagramGUID)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Gets diagram details, in XML format.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">DiagramGUID: String - the GUID (in XML format) of the diagram to get details for.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">GetElement (s</span><span class="f_Tabletext" style="font-weight: bold;">tring ElementGUID</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Gets XML for the specified element.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">ElementGUID: String - the GUID (in XML format) of the element to retrieve XML for.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">GetElementConstraints </span><span class="f_Tabletext" style="font-weight: bold;">(string ElementGUID</span><span class="f_Tabletext" style="font-style: italic; font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Gets constraints for an element, in XML format.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">ElementGUID: String - the GUID (in XML format) of the element.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">GetElementEffort (s</span><span class="f_Tabletext" style="font-weight: bold;">tring ElementGUID</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Gets efforts for an element, in XML format.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">ElementGUID: String - the GUID (in XML format) of the element.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">GetElementFiles (s</span><span class="f_Tabletext" style="font-weight: bold;">tring ElementGUID)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Gets metrics for an element, in XML format.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">ElementGUID: String - the GUID (in XML format) of the element.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">GetElementMetrics (s</span><span class="f_Tabletext" style="font-weight: bold;">tring ElementGUID)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Gets files for an element, in XML format.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">ElementGUID: String - the GUID (in XML format) of the element.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">GetElementProblems (s</span><span class="f_Tabletext" style="font-weight: bold;">tring ElementGUID)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Gets a list of issues (problems) associated with an element, in XML format.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">ElementGUID: String - the GUID (in XML format) of the element.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">GetElementProperties (s</span><span class="f_Tabletext" style="font-weight: bold;">tring ElementGUID)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Gets Tagged values for an element, in XML format.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">ElementGUID: String - the GUID (in XML format) of the element.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">GetElementRequirements (s</span><span class="f_Tabletext" style="font-weight: bold;">tring ElementGUID)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Gets a list of requirements for an element, in XML format.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">ElementGUID: String -the GUID (in XML format) of the element.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">GetElementResources (s</span><span class="f_Tabletext" style="font-weight: bold;">tring ElementGUID)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Gets a list of resources for an element, in XML format.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">ElementGUID: String - the GUID (in XML format) of the element.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">GetElementRisks (s</span><span class="f_Tabletext" style="font-weight: bold;">tring ElementGUID)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Gets a list of risks associated with an element, in XML format.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">ElementGUID: String - the GUID (in XML format) of the element.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">GetElementScenarios (s</span><span class="f_Tabletext" style="font-weight: bold;">tring ElementGUID)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Gets a list of scenarios for an element, in XML format. </span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">ElementGUID: String - the GUID (in XML format) of the element.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">GetElementTests (s</span><span class="f_Tabletext" style="font-weight: bold;">tring ElementGUID)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Gets a list of tests for an element, in XML format. </span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters: </span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">ElementGUID: String - the GUID (in XML format) of the element.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">GetLastError ()</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Returns a string value describing the most recent error that occurred in relation to this object.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">This function is rarely used as an exception is thrown when an error occurs.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">GetLink (s</span><span class="f_Tabletext" style="font-weight: bold;">tring LinkGUID)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Gets connector details, in XML format.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">LinkGUID: String - the GUID (in XML format) of the connector to get details of.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><a name="guidxml"></a><span class="f_Tabletext" style="font-weight: bold;">GUIDtoXML (s</span><span class="f_Tabletext" style="font-weight: bold;">tring GUID</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Changes an internal GUID to the form used in XML.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">GUID: String - the Enterprise Architect style GUID to convert to XML format.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ImportDirectory (s</span><span class="f_Tabletext" style="font-weight: bold;">tring PackageGUID, string Language, string DirectoryPath, string ExtraOptions)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Imports a source code directory into the model.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">PackageGUID: String - the GUID (in XML format) of the package to reverse engineer code into.</span></li>
<li><span class="f_Bulletlist1">Language: String - specifies the language of the code to be imported.</span></li>
<li><span class="f_Bulletlist1">DirectoryPath: String - specifies the path where the code is found on the computer.</span></li>
<li><span class="f_Bulletlist1">ExtraOptions: String - enables extra options to be given to the command; currently enables import of source from all child directories</span><span class="f_Tabletext"> (</span><span class="f_Tabletext" style="font-style: italic;">recurse</span><span class="f_Tabletext">)</span><span class="f_Bulletlist1"> - for example: </span><span class="f_Tabletext" style="font-style: italic;">recurse=</span><span class="f_Tabletext" style="font-weight: bold;">1</span><span class="f_Tabletext">.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ImportFile (s</span><span class="f_Tabletext" style="font-weight: bold;">tring PackageGUID, string Language, string FileName, string ExtraOptions)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Imports an individual file or binary module into the model, in a package per namespace style import.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">PackageGUID: String - the GUID (in XML format) of the package to reverse engineer code into; this is expected to be a namespace root package.</span></li>
<li><span class="f_Bulletlist1">Language: String - specifies the language of the code to be imported.</span></li>
</ul>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 4px 2px 4px 2px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" bgcolor="#efeff7" style="background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Note:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td bgcolor="#f7f7ff" style="background-color:#f7f7ff;"><p class="p_TiporNoteText"><span class="f_TiporNoteText">Use the value &quot;DNPE&quot; to import a binary module. This imports a </span><span class="f_Tabletext">.Net assembly or Java .class file, but </span><span class="f_Tabletext" style="font-weight: bold;">not</span><span class="f_Tabletext"> a .jar file.</span></p>
</td>
</tr>
</table>
</div>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">Filename: String - specifies the path where the code or module is found on the computer.</span></li>
<li><span class="f_Bulletlist1">ExtraOptions: String - enables extra options to be given to the command; </span><span class="f_Tabletext" style="color: #ff0000;">currently unused</span><span class="f_Tabletext">.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ImportPackageXMI (s</span><span class="f_Tabletext" style="font-weight: bold;">tring PackageGUID, string Filename, long ImportDiagrams, long StripGUID)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Imports an XMI file at a point in the tree.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">PackageGUID: String - the GUID (in XML format) of the target package to import the XMI file into (or overwrite with the XMI file).</span></li>
<li><span class="f_Bulletlist1">Filename or XMLText: String - the name of the XMI file.</span></li>
</ul>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 4px 2px 4px 2px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" bgcolor="#efeff7" style="background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Note:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td bgcolor="#f7f7ff" style="background-color:#f7f7ff;"><p class="p_TiporNoteText"><span class="f_TiporNoteText">If the String is of type </span><span class="f_TiporNoteText" style="font-style: italic;">filename</span><span class="f_TiporNoteText"> it is interpreted as a source file, otherwise the String is imported as XML text.</span></p>
</td>
</tr>
</table>
</div>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">ImportDiagrams: Long.</span></li>
<li><span class="f_Bulletlist1">StripGUID: Long - boolean value to indicate whether to replace the element UniqueIDs on import; if stripped, then a package could be imported twice into Enterprise Architect, as two different versions.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">LayoutDiagram (s</span><span class="f_Tabletext" style="font-weight: bold;">tring DiagramGUID, long LayoutStyle</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold; color: #ff0000;">Deprecated.</span><span class="f_Tabletext"> it is recommended that </span><span class="f_Tabletext" style="font-style: italic;">LayoutDiagramEx</span><span class="f_Tabletext"> is used instead.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Calls the function to automatically layout a diagram in hierarchical fashion. It is only recommended for Class and Object diagrams.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">DiagramGUID: String - the GUID (in XML format) of the diagram to lay out.</span></li>
<li><span class="f_Bulletlist1">LayoutStyle: Long - always ignored.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">LayoutDiagramEx (s</span><span class="f_Tabletext" style="font-weight: bold;">tring DiagramGUID, long LayoutStyle, long Iterations, long LayerSpacing, long ColumnSpacing, boolean SaveToDiagram</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Calls the function to automatically layout a diagram in hierarchical fashion. It is only recommended for Class and Object diagrams.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">DiagramGUID: String - the GUID (in XML format) of the diagram to lay out.</span></li>
<li><span class="f_Bulletlist1">LayoutStyle: Long - the layout style.</span></li>
<li><span class="f_Bulletlist1">Iterations: Long - the number of layout iterations the Layout process should take to perform cross reduction (Default value =</span><span class="f_Tabletext"> </span><span class="f_Tabletext" style="font-weight: bold;">4</span><span class="f_Tabletext">).</span></li>
<li><span class="f_Bulletlist1">LayerSpacing: Long - the per-element layer spacing the Layout process shall use (Default value =</span><span class="f_Tabletext"> </span><span class="f_Tabletext" style="font-weight: bold;">20</span><span class="f_Tabletext">).</span></li>
<li><span class="f_Bulletlist1">ColumnSpacing: Long - the per-element column spacing the Layout process shall use (Default value = </span><span class="f_Tabletext" style="font-weight: bold;">20</span><span class="f_Tabletext">).</span></li>
<li><span class="f_Bulletlist1">SaveToDiagram: Boolean - specifies whether or not Enterprise Architect should save the supplied layout options as default to the diagram in question.</span></li>
</ul>
<p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">LayoutStyle</span><span class="f_Tabletext"> accepts the following options (also see </span><span class="f_Tabletext" style="font-style: italic;"><a href="constlayoutstylesenum.htm">ConstLayoutStyles Enum</a></span><span class="f_Tabletext">):</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">Default Options:</span></li>
</ul>
<p class="p_Bulletlist3"><span class="f_Bulletlist3">lsDiagramDefault</span></p>
<p class="p_Bulletlist3"><span class="f_Bulletlist3">lsProgramDefault.</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">Cycle Removal Options:</span></li>
</ul>
<p class="p_Bulletlist3"><span class="f_Bulletlist3">lsCycleRemoveGreedy</span></p>
<p class="p_Bulletlist3"><span class="f_Bulletlist3">lsCycleRemoveDFS.</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">Layering Options:</span></li>
</ul>
<p class="p_Bulletlist3"><span class="f_Bulletlist3">lsLayeringLongestPathSink</span></p>
<p class="p_Bulletlist3"><span class="f_Bulletlist3">lsLayeringLongestPathSource</span></p>
<p class="p_Bulletlist3"><span class="f_Bulletlist3">lsLayeringOptimalLinkLength.</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">Initialize Options:</span></li>
</ul>
<p class="p_Bulletlist3"><span class="f_Bulletlist3">IsInitializeNaive</span></p>
<p class="p_Bulletlist3"><span class="f_Bulletlist3">IsInitializeDFSOut</span></p>
<p class="p_Bulletlist3"><span class="f_Bulletlist3">IsInitializeDFSIn.</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">Crossing Reduction Option:</span></li>
</ul>
<p class="p_Bulletlist3"><span class="f_Bulletlist3">lsCrossReduceAggressive.</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">Layout Options - Direction</span></li>
</ul>
<p class="p_Bulletlist3"><span class="f_Bulletlist3">lsLayoutDirectionUp</span></p>
<p class="p_Bulletlist3"><span class="f_Bulletlist3">lsLayoutDirectionDown</span></p>
<p class="p_Bulletlist3"><span class="f_Bulletlist3">lsLayoutDirectionLeft</span></p>
<p class="p_Bulletlist3"><span class="f_Bulletlist3">lsLayoutDirectionRight</span><span class="f_Tabletext">.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">LoadControlledPackage (</span><span class="f_Tabletext" style="font-weight: bold;">string PackageGUID</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Loads a package that has been marked and configured as controlled. The filename details are stored in the package control data.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">PackageGUID: String - the GUID (in XML format) of the package to load.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">LoadDiagram (s</span><span class="f_Tabletext" style="font-weight: bold;">tring DiagramGUID</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Loads a diagram by its GUID.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameter:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">DiagramGUID: String - the GUID (in XML format) of the diagram to load; if you retrieve the GUID using the Diagram interface, use the </span><span class="f_Bulletlist1" style="font-style: italic;"><a href="project_2.htm#GUIDXML">GUIDtoXML</a></span><span class="f_Bulletlist1"> function to convert it to XML format.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">LoadProject (s</span><span class="f_Tabletext" style="font-weight: bold;">tring FileName</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Loads an Enterprise Architect project file. Do not use this method if you have accessed the Project interface from the Repository, which has already loaded a file.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">FileName: String - the name of the project file to load.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">PutDiagramImageOnClipboard (</span><span class="f_Tabletext" style="font-weight: bold;">string DiagramGUID, long Type</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Copies an image of the specified diagram to the clipboard.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">DiagramGUID: String - the GUID (in XML format) of the diagram to copy.</span></li>
<li><span class="f_Bulletlist1">Type: Long - the file type.</span></li>
</ul>
<ul style="text-indent: 0px; margin-left: 48px; list-style-position: outside;">
<li><span class="f_Bulletlist2">If Type = </span><span class="f_Bulletlist2" style="font-weight: bold;">0</span><span class="f_Bulletlist2"> then it is a metafile</span></li>
<li><span class="f_Bulletlist2">If Type = </span><span class="f_Bulletlist2" style="font-weight: bold;">1</span><span class="f_Bulletlist2"> then it is a Device Independent Bitmap.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">PutDiagramImageToFile (s</span><span class="f_Tabletext" style="font-weight: bold;">tring Diagram GUID, string FileName, long Type</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Saves an image of the specified diagram to file.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">DiagramGUID: String - the GUID (in XML format) of the diagram to save.</span></li>
<li><span class="f_Bulletlist1">FileName: String - the name of the file to save the diagram into.</span></li>
<li><span class="f_Bulletlist1">Type: Long - the file type.</span></li>
</ul>
<ul style="text-indent: 0px; margin-left: 48px; list-style-position: outside;">
<li><span class="f_Bulletlist2">If type = </span><span class="f_Bulletlist2" style="font-weight: bold;">0</span><span class="f_Bulletlist2"> then it is a metafile</span></li>
<li><span class="f_Bulletlist2">If type = </span><span class="f_Bulletlist2" style="font-weight: bold;">1</span><span class="f_Bulletlist2"> then it uses the file type from the name extension (that is, .bmp, .jpg, .gif, .png, .tga)</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ReloadProject ()</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Reloads the current project. This is a convenient method to refresh the current loaded project (in case of outside changes to the .EAP file).</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">RunReport (s</span><span class="f_Tabletext" style="font-weight: bold;">tring PackageGUID, string TemplateName, string Filename</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">Void</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Runs a named RTF report.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">PackageGUID: String - the GUID (in XML format) of the package to run the report on.</span></li>
<li><span class="f_Bulletlist1">TemplateName: String - the RTF report template to use. If the PackageGUID has a stereotype of </span><span class="f_Bulletlist1" style="font-style: italic;">MasterDocument</span><span class="f_Bulletlist1">, the template is not required.</span></li>
<li><span class="f_Bulletlist1">FileName: String - the file name to store the generated report in.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">RunHTMLReport (s</span><span class="f_Tabletext" style="font-weight: bold;">tring PackageGUID, string ExportPath, string ImageFormat, string Style, string Extension</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Runs an HTML report (same as </span><span class="f_MenuKeyField">Documentation | HTML Documentation</span><span class="f_Tabletext"> on right-click of package in the </span><span class="f_UIControl">Project Browser</span><span class="f_Tabletext">).</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">PackageGUID: String - the GUID (in XML format) of the package to run the report on.</span></li>
<li><span class="f_Bulletlist1">ExportPath: String - the file name to store the generated report in.</span></li>
<li><span class="f_Bulletlist1">ImageFormat: String.</span></li>
<li><span class="f_Bulletlist1">Style: String.</span></li>
<li><span class="f_Bulletlist1">Extension: String.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">SaveControlledPackage (s</span><span class="f_Tabletext" style="font-weight: bold;">tring PackageGUID</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Saves a package that has been configured as a controlled package, to XMI. Only the package GUID is required, Enterprise Architect picks the rest up from the package control information.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameter:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">PackageGUID: String - the GUID (in XML format) of the package to save.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">SaveDiagramImageToFile (s</span><span class="f_Tabletext" style="font-weight: bold;">tring Filename</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Saves a diagram image of the current diagram to file.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">FileName: String - the filename of the image to save.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ShowWindow (</span><span class="f_Tabletext" style="font-weight: bold;">long Show</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">protected abstract: </span><span class="f_Tabletext" style="font-style: italic;">Void</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Shows or hides the Enterprise Architect User Interface.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">Show: Long.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">SynchronizeClass </span><span class="f_Tabletext" style="font-weight: bold;">(string ElementGUID, string ExtraOptions</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Synchronizes a Class with the latest source code.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">ElementGUID: String - the GUID (in XML format) of the element to update from code.</span></li>
<li><span class="f_Bulletlist1">ExtraOptions: String - enables extra options to be given to the command; currently unused.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">SynchronizePackage </span><span class="f_Tabletext" style="font-weight: bold;">(string PackageGUID, string ExtraOptions</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Synchronizes each Class in a package with the latest source code.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">PackageGUID: String - the GUID (in XML format) of the package containing the elements to update from code.</span></li>
<li><span class="f_Bulletlist1">ExtraOptions: String - enables extra options to be given to the command; currently enables synchronization of all child packages (children) - for example</span><span class="f_Tabletext">: </span><span class="f_Tabletext" style="font-style: italic;">children=1.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">TransformElement </span><span class="f_Tabletext" style="font-weight: bold;">(string TransformName, string ElementGUID, string TargetPackage, string ExtraOptions</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Transforms an element into a package.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">TransformName: String - specifies the transformation that should be executed.</span></li>
<li><span class="f_Bulletlist1">ElementGUID: String - the GUID (in XML format) of the element to transform.</span></li>
<li><span class="f_Bulletlist1">TargetPackageGUID: String - the GUID (in XML format) of the package to transform into.</span></li>
<li><span class="f_Bulletlist1">ExtraOptions: String - enables extra options to be given to the command; currently unused</span><span class="f_Tabletext">.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">TransformPackage </span><span class="f_Tabletext" style="font-weight: bold;">(string TransformName, string SourcePackage, string TargetPackage, string ExtraOptions</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Runs a transformation on the contents of a package.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">TransformName: String - specifies the transformation that should be executed.</span></li>
<li><span class="f_Bulletlist1">SourcePackageGUID: String - the GUID (in XML format) of the package to transform.</span></li>
<li><span class="f_Bulletlist1">TargetPackageGUID: String - the GUID (in XML format) of the package to transform into.</span></li>
<li><span class="f_Bulletlist1">ExtraOptions: String - enables extra options to be given to the command; currently unused.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="200" style="width:200px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">XMLtoGUID </span><span class="f_Tabletext" style="font-weight: bold;">(string GUID)</span></p>
</td>
<td valign="top" width="116" style="width:116px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="339" style="width:339px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Changes a GUID in XML format to the form used inside Enterprise Architect.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 15px; list-style-position: outside;">
<li><span class="f_Bulletlist1">GUID: String - the XML style GUID to convert to Enterprise Architect internal format.</span></li>
</ul>
</td>
</tr>
</table>
</div>




            </div>
          </div>
        </div>



</div>


</body>
</html>
